

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Public Hearing Transcripts API &mdash; Open Legislation 2.0-alpha documentation</title>
  

  
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="genindex.html"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="Open Legislation 2.0-alpha documentation" href="index.html"/>
        <link rel="next" title="Senate Members API" href="members.html"/>
        <link rel="prev" title="Senate Floor Transcripts API" href="transcripts_floor.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="reference.html" class="icon icon-home"> Open Legislation
          

          
          </a>

          
            
            
              <div class="version">
                2.0
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html"><strong>Open Legislation v2.0 API Docs</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="bills.html"><strong>Bills and Resolutions API</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="calendars.html"><strong>Senate Calendar API</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="agendas.html"><strong>Senate Agenda API</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="committees.html"><strong>Senate Committee API</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="laws.html"><strong>NYS Laws API</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="transcripts_floor.html"><strong>Senate Floor Transcripts API</strong></a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#"><strong>Public Hearing Transcripts API</strong></a><ul>
<li class="toctree-l2"><a class="reference internal" href="#get-a-single-public-hearing">Get a single Public Hearing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#get-a-public-hearing-pdf">Get a public hearing pdf</a></li>
<li class="toctree-l2"><a class="reference internal" href="#get-a-list-of-public-hearings">Get a list of public hearings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="members.html"><strong>Senate Members API</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="agg_updates.html"><strong>Aggregate Updates API</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="search_api.html"><strong>Search APIs</strong></a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="reference.html">Open Legislation</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="reference.html">Docs</a> &raquo;</li>
        
      <li><strong>Public Hearing Transcripts API</strong></li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/transcripts_ph.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="public-hearing-transcripts-api">
<h1><strong>Public Hearing Transcripts API</strong><a class="headerlink" href="#public-hearing-transcripts-api" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Assembly public hearings are not available at this time.</p>
</div>
<div class="section" id="get-a-single-public-hearing">
<h2>Get a single Public Hearing<a class="headerlink" href="#get-a-single-public-hearing" title="Permalink to this headline">¶</a></h2>
<p><strong>Usage</strong></p>
<p>Retrieve public hearing by filename</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">GET</span><span class="p">)</span> <span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mi">3</span><span class="o">/</span><span class="n">hearings</span><span class="o">/</span><span class="p">{</span><span class="n">filename</span><span class="p">}</span>
</pre></div>
</div>
<p><strong>Examples</strong></p>
<p>Request public hearing &#8220;10-29-13 NYsenate_Flanagan_Education_FINAL.txt&#8221;</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mi">3</span><span class="o">/</span><span class="n">hearings</span><span class="o">/</span><span class="mi">10</span><span class="o">-</span><span class="mi">29</span><span class="o">-</span><span class="mi">13</span> <span class="n">NYsenate_Flanagan_Education_FINAL</span><span class="o">.</span><span class="n">txt</span>
</pre></div>
</div>
<p><strong>Response</strong></p>
<p>Full Public Hearing Response</p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;success&quot;</span> <span class="o">:</span> <span class="kc">true</span><span class="p">,</span>                               <span class="c1">// Indicates if a public hearing was found.</span>
  <span class="s2">&quot;message&quot;</span> <span class="o">:</span> <span class="s2">&quot;Data for public hearing 10-29..&quot;</span><span class="p">,</span>  <span class="c1">// Response description</span>
  <span class="s2">&quot;responseType&quot;</span> <span class="o">:</span> <span class="s2">&quot;hearing&quot;</span><span class="p">,</span>                     <span class="c1">// Response data type</span>
  <span class="s2">&quot;result&quot;</span> <span class="o">:</span> <span class="p">{</span>
    <span class="s2">&quot;filename&quot;</span> <span class="o">:</span> <span class="s2">&quot;10-29-13 NYsenate_Flanagan..&quot;</span><span class="p">,</span>  <span class="c1">// Filename of public hearing transcript</span>
    <span class="s2">&quot;title&quot;</span> <span class="o">:</span> <span class="s2">&quot;PUBLIC HEARING THE REGENTS RE..&quot;</span><span class="p">,</span>  <span class="c1">// Title of public hearing</span>
    <span class="s2">&quot;date&quot;</span> <span class="o">:</span> <span class="s2">&quot;2013-10-29&quot;</span><span class="p">,</span>                        <span class="c1">// Date of public hearing</span>
    <span class="s2">&quot;address&quot;</span> <span class="o">:</span> <span class="s2">&quot;Senate Hearing Room\n250 Br..&quot;</span><span class="p">,</span>  <span class="c1">// Address of public hearing</span>
    <span class="s2">&quot;committees&quot;</span> <span class="o">:</span> <span class="p">[</span> <span class="p">{</span>                            <span class="c1">// List of committees/task forces/other groups holding the hearing</span>
      <span class="s2">&quot;name&quot;</span> <span class="o">:</span> <span class="s2">&quot;EDUCATION&quot;</span><span class="p">,</span>                       <span class="c1">// Name of committee/task force/other group</span>
      <span class="s2">&quot;chamber&quot;</span> <span class="o">:</span> <span class="s2">&quot;SENATE&quot;</span>                        <span class="c1">// Chamber of committee</span>
    <span class="p">}</span> <span class="p">],</span>
    <span class="s2">&quot;startTime&quot;</span> <span class="o">:</span> <span class="s2">&quot;10:00&quot;</span><span class="p">,</span>                        <span class="c1">// Time the public hearing started</span>
    <span class="s2">&quot;endTime&quot;</span> <span class="o">:</span> <span class="s2">&quot;14:00&quot;</span><span class="p">,</span>                          <span class="c1">// Time the public hearing ended</span>
    <span class="s2">&quot;text&quot;</span> <span class="o">:</span> <span class="s2">&quot;\n\n\n       1     BEFORE THE NE..&quot;</span> <span class="c1">// The text of the public hearing</span>
    <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="get-a-public-hearing-pdf">
<h2>Get a public hearing pdf<a class="headerlink" href="#get-a-public-hearing-pdf" title="Permalink to this headline">¶</a></h2>
<p><strong>Usage</strong></p>
<p>Retrieve public hearing pdf by filename</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">GET</span><span class="p">)</span> <span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mi">3</span><span class="o">/</span><span class="n">hearings</span><span class="o">/</span><span class="p">{</span><span class="n">filename</span><span class="p">}</span><span class="o">.</span><span class="n">pdf</span>
</pre></div>
</div>
<p><strong>Examples</strong></p>
<p>Request public hearing 09-12-13 NYSsenate_DeFrancisco_Buffalo_FINAL.txt</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mi">3</span><span class="o">/</span><span class="n">hearings</span><span class="o">/</span><span class="mi">09</span><span class="o">-</span><span class="mi">12</span><span class="o">-</span><span class="mi">13</span> <span class="n">NYSsenate_DeFrancisco_Buffalo_FINAL</span><span class="o">.</span><span class="n">txt</span><span class="o">.</span><span class="n">pdf</span>
</pre></div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="get-a-list-of-public-hearings">
<h2>Get a list of public hearings<a class="headerlink" href="#get-a-list-of-public-hearings" title="Permalink to this headline">¶</a></h2>
<p><strong>Usage</strong></p>
<p>List public hearings within a year</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">GET</span><span class="p">)</span> <span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mi">3</span><span class="o">/</span><span class="n">hearings</span><span class="o">/</span><span class="p">{</span><span class="n">year</span><span class="p">}</span>
</pre></div>
</div>
<p><strong>Optional Params</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="13%" />
<col width="23%" />
<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Values</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>limit</td>
<td>1 - 1000</td>
<td>Number of results to return</td>
</tr>
<tr class="row-odd"><td>offset</td>
<td>&gt; 1</td>
<td>Result number to start from</td>
</tr>
<tr class="row-even"><td>full</td>
<td>boolean</td>
<td>Set to true to see the full public hearing responses.</td>
</tr>
<tr class="row-odd"><td>sort</td>
<td>string</td>
<td>Sort by any field from the response.</td>
</tr>
</tbody>
</table>
<p><strong>Examples</strong></p>
<p>List 50 public hearings from 2014</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>/api/3/hearings/2014?limit=50
</pre></div>
</div>
<p>List 50 complete public hearings starting from 51</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>/api/3/hearings/2014?limit=50%offset=51&amp;full=true
</pre></div>
</div>
<p>List 10 complete public hearings sorted by increasing date</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>/api/3/hearings/2014?limit=10&amp;full=true&amp;sort=dateTime:ASC
</pre></div>
</div>
<p><strong>Response</strong></p>
<div class="highlight-javascript"><div class="highlight"><pre><span></span><span class="p">{</span>
  <span class="s2">&quot;success&quot;</span> <span class="o">:</span> <span class="kc">true</span><span class="p">,</span>                               <span class="c1">// True if request was fine.</span>
  <span class="s2">&quot;message&quot;</span> <span class="o">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
  <span class="s2">&quot;responseType&quot;</span> <span class="o">:</span> <span class="s2">&quot;hearing-id list&quot;</span><span class="p">,</span>
  <span class="s2">&quot;total&quot;</span> <span class="o">:</span> <span class="mi">451</span><span class="p">,</span>                                  <span class="c1">// Total public hearings in the listing</span>
  <span class="s2">&quot;offsetStart&quot;</span> <span class="o">:</span> <span class="mi">1</span><span class="p">,</span>                              <span class="c1">// Offset value</span>
  <span class="s2">&quot;offsetEnd&quot;</span> <span class="o">:</span> <span class="mi">0</span><span class="p">,</span>                                <span class="c1">// To paginate, set query param offset = {offsetEnd + 1}</span>
  <span class="s2">&quot;limit&quot;</span> <span class="o">:</span> <span class="mi">10</span><span class="p">,</span>                                   <span class="c1">// Max number of results to show</span>
  <span class="s2">&quot;result&quot;</span> <span class="o">:</span> <span class="p">{</span>
    <span class="s2">&quot;items&quot;</span><span class="o">:</span> <span class="p">[{</span> <span class="p">...</span> <span class="p">}],</span>                           <span class="c1">// Array of public hearing responses</span>
    <span class="s2">&quot;size&quot;</span><span class="o">:</span> <span class="mi">10</span>
  <span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="members.html" class="btn btn-neutral float-right" title="Senate Members API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="transcripts_floor.html" class="btn btn-neutral" title="Senate Floor Transcripts API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2014, NY State Senate Technology Services.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'2.0-alpha',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>